<?php

namespace ApiBundle\Document;

use RedUnicorn\Document\Document;

class ApiDocument extends Document
{
    public function add()
    {
        $this->addParam('platform', '平台', 'string', false);
        $this->addParam('version', '版本号', 'string', true, '', '移动设备端必传');

        return parent::add();
    }

    public function setUrl($url)
    {
        return parent::setUrl('/api' . $url);
    }

    /**
     * 添加分页参数
     *
     * @return $this
     */
    public function addPaginationParam()
    {
        $this->addParam('page', '分页页码', 'integer', true, 1);
        $this->addParam('rows', '分页行数', 'integer', true, 15);
        return $this;
    }

    /**
     * 添加插入或编辑主键参数
     *
     * @param $name
     * @param $comment
     * @return $this
     */
    public function addInsertOrUpdateIdParam($name, $comment)
    {
        return $this->addParam($name, $comment, 'string', false, 0, ' 0 为添加 其他为编辑');
    }
}